Skip to main content
Version: 5.4

Configuration Service

TimePunch's configuration service provides methods for reading and/or saving settings in TimePunch.

LoadAttendanceSettings

This method returns the global settings of the Attendance list module.

AttendanceSettingsDto LoadAttendanceSettings(  
out TpFault fault,
TpAuthentication authentication);
Needed Permissioncore@logon
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
Return valueInformation about the attendance settings

SaveAttendanceSettings

This method allows you to save the global settings for the Attendance list module.

void SaveAttendanceSettings(  
out TpFault fault,
TpAuthentication authentication,
AttendanceSettingsDto attendanceSettings);
Needed Permissioncore@administrate
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
attendanceSettingsInformation about the attendance settings

LoadCostCenterSettings

This method returns the cost centers defined in TimePunch for the different posting types.

CostCenterDto LoadCostCenterSettings(  
out TpFault fault,
TpAuthentication authentication);
Needed Permissioncore@logon
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
Return valueInformation about the cost centers

SaveCostCenterSettings

This method allows you to save the cost centers for the different booking types in TimePunch.

void SaveCostCenterSettings(  
out TpFault fault,
TpAuthentication authentication,
CostCenterDto costCenter);
Needed Permissiondatev@export
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
costCenterInformation about the cost centers

LoadDatevExportSettings

This method loads the settings for exporting to DATEV.

GlobalSalaryExportDto LoadDatevExportSettings(  
out TpFault fault,
TpAuthentication authentication);
Needed Permissioncore@logon
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
Return valueInformation about the datev settings

SaveDatevExportSettings

This method saves the settings for the DATEV export.

void SaveDatevExportSettings(  
out TpFault fault,
TpAuthentication authentication,
GlobalSalaryExportDto datevExport);
Needed Permissiondatev@export
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
datevExportInformation about the datev settings

LoadMailSettings

This method loads the settings for automatic mail sending in TimePunch.

AutomatedMailsDto LoadMailSettings(  
out TpFault fault,
TpAuthentication authentication);
Needed Permissioncore@logon
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
Return valueInformation about the automated mail settings

SaveMailSettings

This method saves the settings for automatic mail sending in TimePunch.

void SaveMailSettings(  
out TpFault fault,
TpAuthentication authentication,
MailSettingsDto mailSettings);
Needed Permissioncore@administrate
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
mailSettingsInformation about the automated mail settings

LoadUserSettings

This method loads settings that affect all users equally and cause a special behavior in TimePunch.

UserSettingsDto LoadUserSettings(  
out TpFault fault,
TpAuthentication authentication);
Needed Permissioncore@logon
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
Return valueUser settings object

SaveUserSettings

This method saves the settings for the special behavior in TimePunch.

void SaveUserSettings(  
out TpFault fault,
TpAuthentication authentication,
UserSettingsDto userSettings);
Needed Permissioncore@administrate
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
userSettingsInformation about the datev settings

LoadUserSalaryExportDto

This method loads the employee-specific settings for wage data export into a payroll program.

List<UserSalaryExportDto> LoadUserSalaryExportDto(  
out TpFault fault,
TpAuthentication authentication,
List<Guid> userIds);
Needed PermissionsalaryExport@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
userIdsUser Ids to load the salary export dto
Return valueSalary export settings per user

SaveUserSalaryExportDto

This method saves the employee-specific settings for the wage data export.

void SaveUserSalaryExportDto(  
out TpFault fault,
TpAuthentication authentication,
List<UserSalaryExportDto> salaryExportDtos);
Needed Permissioncore@administrate
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
salaryExportDtosSalary export settings per user

LoadDocumentStoreConfiguration

This method loads the document store configuration from the application server.

DocumentStoreConfigurationDto LoadDocumentStoreConfiguration(  
out TpFault fault,
TpAuthentication authentication);
Needed PermissiondocumentStore@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
Return valueDocument storage configuration

SaveDocumentStoreConfiguration

This method writes the configuration of the document store in the application server.

void SaveDocumentStoreConfiguration(  
out TpFault fault,
TpAuthentication authentication,
DocumentStoreConfigurationDto configuration);
Needed Permissioncore@administrate
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
configurationThe document storage configuration

LoadVisualSettings

This method loads the UI settings from TimePunch.

VisualSettingsDto LoadVisualSettings(
out TpFault fault,
TpAuthentication authentication);
Needed Permission---
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
Return ValueThe visual settings object

SaveVisualSettings

This method saves the UI settings of TimePunch.

void SaveVisualSettings(
out TpFault fault,
TpAuthentication authentication,
VisualSettingsDto visualSettings);
Needed Permissioncore@administrate
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
visualSettingsThe visual settings object

LoadRetroactiveProjectAssignment

This method loads the settings for retrospective project assignment.

RetroactiveProjectAssignmentDto LoadRetroactiveProjectAssignment(
out TpFault fault,
TpAuthentication authentication);
Needed Permission---
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
Return ValueThe retroactive project settings

SaveRetroactiveProjectAssignment

This method saves the settings for retroactive project assignment.

void SaveRetroactiveProjectAssignment(
out TpFault fault,
TpAuthentication authentication,
RetroactiveProjectAssignmentDto RetroactiveProjectAssignment);
Needed Permissioncore@administrate
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
RetroactiveProjectAssignmentThe retroactive project settings object